Investigator API

POST Search RateDirectory

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

OperationId: POST Search RateDirectory

Authorization Method(s): OAuth

Verb: POST

End Point: /api/ratedirectory/search

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
Client Number *	clientNumber	string
Search Country	searchCountry	SearchCountry
Search Option	searchOption	SearchOption
Search Type	searchType	string
Filters	filters	RateDirectorySearchFilters
Parameters	parameters	RateDirectorySearchParameters

SearchCountry

Display Name	Field Name	Field Type

SearchOption

Display Name	Field Name	Field Type

RateDirectorySearchFilters

Display Name	Field Name	Field Type
Release Number	releaseNumber	integer
Date Type	dateType	SearchDateType

SearchDateType

Display Name	Field Name	Field Type

RateDirectorySearchParameters

Display Name	Field Name	Field Type
Geocode	geocode	string
Locations	locations	array[]
Postal Code	postalCode	string
Npanxx	npanxx	string
State County City	stateCountyCity	StateCountyCity
State	state	States
As Of Date	asOfDate	DataYearMonth
Address	address	Address
Current Page	currentPage	integer
Page Size	pageSize	integer

StateCountyCity

Display Name	Field Name	Field Type
State *	state	string
County	county	string
City	city	string

States

Display Name	Field Name	Field Type
State	state	string

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

Address

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
County	county	string
Postal Code	postalCode	string
Plus4	plus4	string
State	state	string

Example Request

{
  "filters": {
    "releaseNumber": null,
    "dateType": "Date"
  },
  "parameters": {
    "geocode": null,
    "locations": [],
    "postalCode": null,
    "npanxx": null,
    "stateCountyCity": null,
    "state": null,
    "asOfDate": {
      "year": "2025",
      "month": "02",
      "day": 1
    },
    "address": {
      "address1": "",
      "address2": "",
      "city": "",
      "county": "",
      "postalCode": "",
      "plus4": "",
      "state": ""
    },
    "currentPage": 0,
    "pageSize": 0
  },
  "clientNumber": "${Client Number}",
  "searchCountry": "UnitedStates",
  "searchOption": "Location",
  "searchType": "RateDirectory"
}

Query Parameters

Display String	Field Name	Field Type
Api-version*	api-version	undefined

*Mandatory parameter

ProblemDetails

OVERVIEWEXAMPLE

Overview

ProblemDetails

Display Name	Field Name	Field Type
Type	type	string
Title	title	string
Status	status	integer
Detail	detail	string
Instance	instance	string

Example Response

{
  "results": [
    {
      "locationID": "",
      "state": "",
      "county": "",
      "city": "",
      "local": "",
      "postalCode": "",
      "plus4": "",
      "sales_Use": "",
      "federal_TaxRate": 0,
      "state_TaxRate": 0,
      "county_TaxRate": 0,
      "city_TaxRate": 0,
      "local_TaxRate": 0,
      "effectiveDate": "2025-03-12T13:54:43.8763953-06:00",
      "total_TaxRate": 2,
      "totalPages": 1
    }
  ],
  "locationResults": [
    {
      "locationId": "",
      "results": [
        {
          "locationID": "",
          "state": "",
          "county": "",
          "city": "",
          "local": "",
          "postalCode": "",
          "plus4": "",
          "sales_Use": "",
          "federal_TaxRate": 0,
          "state_TaxRate": 0,
          "county_TaxRate": 0,
          "city_TaxRate": 0,
          "local_TaxRate": 0,
          "effectiveDate": "2025-03-12T13:54:43.8764012-06:00",
          "total_TaxRate": 2,
          "totalPages": 1
        }
      ]
    }
  ],
  "errors": []
}

Response Codes

code	description
200	RateDirectory search results were successfully returned.
401	Use doesn't have access to use this API.
404	Not Found

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/ratedirectory/search

Add Request Headers:

{
  "filters": {
    "releaseNumber": null,
    "dateType": "Date"
  },
  "parameters": {
    "geocode": null,
    "locations": [],
    "postalCode": null,
    "npanxx": null,
    "stateCountyCity": null,
    "state": null,
    "asOfDate": {
      "year": "2025",
      "month": "02",
      "day": 1
    },
    "address": {
      "address1": "",
      "address2": "",
      "city": "",
      "county": "",
      "postalCode": "",
      "plus4": "",
      "state": ""
    },
    "currentPage": 0,
    "pageSize": 0
  },
  "clientNumber": "${Client Number}",
  "searchCountry": "UnitedStates",
  "searchOption": "Location",
  "searchType": "RateDirectory"
}